Сноски и ссылки

Сноски

Обычно поясняющая информация располагается сразу после поясняемого слова в предложении:

Двести лет назад в Калининграде (в те времена он назывался Кенигсберг) было семь мостов, соединяющих берега реки Прегель.

Чтобы не разбивать повествование, особенно если примечание большое, используются сноски.

Форматирование сноски

В тексте после слова/предложения, которое необходимо пояснить, пишется указатель сноски, состоящий из идентификатора в квадратных скобках [*]. На следующей строке, после вертикальной черты, идентификатора и пробела |* размещается содержимое сноски.

Двести лет назад в Калининграде[*] было семь мостов, соединяющих берега реки Прегель.
|* В те времена он назывался Кенигсберг.

Идентификатор сноски

Идентификатор может состоять из звездочек или из цифр. Цифровой порядковый номер сноски предваряется звездочкой *1 (Сама звёздочка при конвертации отображаться не будет, она указывает на то, что это сноска).

Допустим, в этом абзаце есть некая мысль, которую автор хочет подтвердить источником.[*] Далее идет «Текст конкретной цитаты, взятой из другого источника».[**]
|* См. Иванов И.И. Теоретические основы.-М.:, 2000.-С.25.
|** Петров В.В. Практические основы.-Спб.:, 2022.-С.40.

Допустим, в этом абзаце есть некая мысль, которую автор хочет подтвердить источником.[*1] Далее идет «Текст конкретной цитаты, взятой из другого источника».[*2]
|*1 См. Иванов И.И. Теоретические основы.-М.:, 2000.-С.25.
|*2 Петров В.В. Практические основы.-Спб.:, 2022.-С.40.

Ссылки

Ссылка отличается от сноски тем, что она представляет собой некий путь к объекту на который мы ссылаемся. И при конвертации в электронные форматы она будет преобразована в гиперссылку. Адреса ссылок можно располагать прямо в тексте:

Не все знают, что сайт http://example.com/ специально зарезервирован для указания в примерах.

Однако, ссылки могут быть длинными и мешать восприятию текста. Поэтому выделяется некое словосочетание как тело ссылки, а адрес ссылки выносится за пределы предложения (аналогично сноскам). Тело ссылки заключается в квадратные скобки с тильдой ~[слово]~. Адрес ссылки указывается на следующей строке, которая начинается с вертикальной черты и тильды |~:

Я рекомендую вам прочитать книгу ~[«Ещё один великолепный МИФ»]~ Роберта Асприна.
|~ https://ru.wikipedia.org/wiki/%D0%95%D1%89%D1%91_%D0%BE%D0%B4%D0%B8%D0%BD_%D0%B2%D0%B5%D0%BB%D0%B8%D0%BA%D0%BE%D0%BB%D0%B5%D0%BF%D0%BD%D1%8B%D0%B9_%D0%9C%D0%98%D0%A4

Описание ссылки

Ссылку можно дополнить описанием того, что мы увидим при переходе по ней. Описание указывается в круглых скобках отделенных пробелом.

Я рекомендую вам прочитать книгу ~[«Ещё один великолепный МИФ»]~ Роберта Асприна.
|~ https://ru.wikipedia.org/wiki/Ещё_один_великолепный_МИФ (Подробно в Википедии о книге "Ещё один великолепный МИФ")

Так понятнее куда ведет ссылка. При конвертации в html слова «Ещё один великолепный МИФ» станут гиперссылкой, адрес ссылки запишется в атрибут href, а описание в скобках запишется в атрибут title и будет показываться при наведении на ссылку.

Пример нескольких ссылок

Если в строке несколько гиперссылок, то адреса ссылок указываются в той же последовательности, нумеровать ничего не нужно:

Я рекомендую вам прочитать книгу ~[«Ещё один великолепный МИФ»]~ талантливого и доброго писателя ~[Роберта Асприна]~.
|~ https://ru.wikipedia.org/wiki/Ещё_один_великолепный_МИФ (Упоминание в Википедии книги "Ещё один великолепный МИФ")
|~ https://ru.wikipedia.org/wiki/Асприн,_Роберт_Линн (Асприн, Роберт Линн - Википедия об авторе)

Изображение как ссылка

Допустим, мы хотим разместить обложку книги и привязать к ней гиперссылку на магазин, где эта книга продаётся. Для этого после после закрывающих скобок включения (и после описания) размещаем ссылку. Всё медиа-включение будет считаться ссылкой.

[[
Сноски и ссылки/img/duma20_cover.jpg
]] |~ http://exampleshop.com/Twenty_Years_After--Dumas_Alexandre (Купить книгу "Двадцать лет спустя")

Виды ссылок

Существуют различные виды ссылок:

• Внутренние
  — позволяют осуществлять навигацию внутри произведения (документа) — это сноски либо ссылки на идентификаторы.
• Локальные
  — ссылки на файлы (папки) располагающиеся в том же месте, что и произведение. Например, на изображения или другие тексты.
• Глобальные
  — ссылки на онлайн-ресурсы (страницы, сервисы, файлы, папки), расположенные на других компьютерах в локальной сети, сети Интернет и других сетях.
• Коммуникационные
  — указание на контактные данные в системах телефонии, электронной почты, мессенджерах.

Глобальные и коммуникационные ссылки

Указываются как есть. При конвертации в html они будут размещены в атрибуте href тега a.

Внутренние ссылки документа

Указывают на объект, имеющий идентификатор: включение, заголовок. При конвертации в html пользователь сможет быстро перейти к объекту с указанным идентификатором. Соответственно, не должно быть повторяющихся идентификаторов.

Пример ~[ссылки]~ на включение
|~ #exmpl-2
Какой-то промежуточный текст
[( #exmpl-2
Целевое включение
)]

Пример ~[ссылки]~ на заголовок
|~ #head-n
Какой-то промежуточный текст

--- #head-n
Целевой заголовок

При экспорте в бумажный формат внутренние ссылки пропадают, не преобразуются в сноски?

Локальные ссылки

Мы можем ссылаться на изображения и документы в нашем проекте (файлы на нашем компьютере). Однако есть нюанс. При преобразовании нашего проекта в сайт, имена папок могут преобразовываться, например, транслитерироваться. Соответственно, нам нужно дать указание на то, что эта ссылка является локальной.

Для указания локальной ссылки используйте знак > (больше) в начале адреса ссылки.

Относительность пути

Путь можно указывать двумя способами:

1. Относительно текущего файла.

Если файл на который мы хотим сослаться находится внутри текущей папки в которой находится текстовый файл рядом с ним, то указываем название текущей папки и название этого файла, разделяя названия косой чертой / (слеш).

>Текущая папка/Картинка.jpg

Если требуемый нам файл находится в подпапках текущей папки, то указываем и их.

>Текущая папка/media/images/Картинка.jpg

2. Относительно корня проекта.

Рассматриваем путь как если-бы вы находились в основной папке проекта, а для указания точки отсчёта — корня проекта.

В начале ставим знак слеш /.

>/Мой сборник/Текущая папка/media/images/Картинка.jpg

Как оставить файл .text, чтобы юзер его смог скачать не преобразуя его в html?